Inside Macintosh: QuickDraw GX Objects /

Chapter 4 - Colors and Color-Related Objects / Colors and Color-Related Objects Reference

Color Set Functions / Manipulating Color Set Object Properties

GXGetColorSetTags

You can use the GXGetColorSetTags function to examine one or more of the tag objects associated with a color set object.

long GXGetColorSetTags(gxColorSet source, long tagType, 
                        long index, long count, gxTag items[]);

source

A reference to the color set object to examine the tag list of.

tagType

The type of tag object to search for. A value of 0 indicates that you want to look for all tag types.

index

The (1-based) index of the first such tag reference to return.

count

The number of tag references to return

items

An array to hold the returned tag references.

function result

The number of tag references found that fit the criteria.

DESCRIPTION

The GXGetColorSetTags function searches the tag list of the source color set object for references to tag objects with the tag type specified by the tagType parameter. If you specify 0 for the tagType parameter, the GXGetColorSetTags function searches all tag types.

You can use the index and the count parameters to specify which tag references of the appropriate type the GXGetColorSetTags function should return. The index parameter indicates the first tag reference to return and the count parameter indicates how many tag references to return. The index parameter must be greater than 0. The count parameter must be greater than 0 or equal to the gxSelectToEnd constant (-1), which indicates that all tag references (starting with the tag reference indicated by the index parameter) should be returned.

If you pass a value other than nil for the items parameter, the GXGetColorSetTags function returns in it the tag references that were found. Regardless of the value you pass for items, the function result is the number of tag references found that fit the criteria.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
colorSet_is_nil
index_is_less_than_one	(debugging version)
count_is_less_than_one	(debugging version)
Warnings
index_out_of_range
count_out_of_range

SEE ALSO

Tag objects are discussed in the chapter "Tag Objects" in this book.

To change the set of tag references associated with a color set object, use the GXSetColorSetTags function, described in the next section.